Skip to content

Conversation

@louislelay
Copy link
Contributor

Description

Fixes incorrect dummy agent paths in the template docs and adds dummy agent instructions to the External Project section.

Type of change

  • Documentation update

Checklist

  • I have read and understood the contribution guidelines
  • I have run the pre-commit checks with ./isaaclab.sh --format
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • [N/A] I have added tests that prove my fix is effective or that my feature works
  • [N/A] I have updated the changelog and the corresponding version in the extension's config/extension.toml file
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

@github-actions github-actions bot added bug Something isn't working documentation Improvements or additions to documentation labels Oct 14, 2025
Copy link
Collaborator

@ooctipus ooctipus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@louislelay

Thank you for submitting the FIX!!

Copy link
Collaborator

@ooctipus ooctipus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Greptile Overview

Greptile Summary

This PR corrects documentation paths for dummy agent scripts in the template documentation (template.rst). Isaac Lab supports two project structures: external projects (standalone) and internal tasks (in-repository). External projects store dummy agent scripts at scripts/zero_agent.py and scripts/random_agent.py, while internal tasks organize them under scripts/environments/. The PR adds missing documentation for dummy agents in the External project section and fixes the Internal task paths to include the /environments/ subdirectory, aligning the documentation with the actual file structure of both template types.

Important Files Changed

Filename Score Overview
docs/source/overview/own-project/template.rst 5/5 Adds dummy agent documentation for external projects and corrects internal task dummy agent paths from scripts/ to scripts/environments/

Confidence score: 5/5

  • This PR is safe to merge with minimal risk as it only updates documentation strings with correct file paths
  • Score reflects that this is a documentation-only change with no code logic modifications, clear intent, and proper path corrections verified against the repository structure
  • No files require special attention; the changes are straightforward path corrections in RST documentation

Sequence Diagram

sequenceDiagram
    participant User
    participant "Documentation Reader" as Reader
    participant "External Project" as ExtProj
    participant "Template Generator" as TempGen
    
    User->>Reader: "Read template documentation"
    Reader->>Reader: "See incorrect dummy agent paths"
    User->>TempGen: "Run ./isaaclab.sh --new"
    TempGen->>ExtProj: "Generate external project"
    User->>ExtProj: "python scripts/zero_agent.py --task=<Task-Name>"
    Note over User,ExtProj: Previously incorrect path shown in docs
    User->>ExtProj: "python scripts/random_agent.py --task=<Task-Name>"
    Note over User,ExtProj: Now correctly documented
Loading

1 file reviewed, no comments

Edit Code Review Agent Settings | Greptile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants